package tron.common;

/**
 * 注解使用说明
 */
public interface ReadMe {
    /**
     * @Api()
     * 用于类；表示标识这个类是swagger的资源
     * tags–表示说明
     * @Api(tags = "用户接口")
     */

    /**
     * @ApiModel()
     * 用于类 ；表示对类进行说明，用于参数用实体类接收
     * value–表示对象名
     * description–描述
     * @ApiModel(value = "用户类",description = "新增用户不传id")
     *
     * @ApiModelProperty()
     * 用于方法，字段； 表示对model属性的说明或者数据操作更改
     * value–字段说明
     * name–重写属性名字
     * dataType–重写属性类型
     * required–是否必填
     * example–举例说明
     * hidden–隐藏
     *  @ApiModelProperty(value = "用户生日",example = "2020-10-10")
     */

    /**
     * 方法参数必须有@RequestParam注解
     * @ApiImplicitParam() 
     * 用于方法 
     * 表示单独的请求参数 
     * @ApiImplicitParam(name = "id",value = "用户id",required = true)
     *
     * @ApiImplicitParams() 
     * 用于方法，包含多个 @ApiImplicitParam 
     * name–参数名
     * value–参数说明 
     * dataType–数据类型 
     * paramType–参数类型 
     * example–举例说明
     *
     * @ApiImplicitParams(value = {
     *     @ApiImplicitParam(name = "page",value = "页码"),
     *     @ApiImplicitParam(name = "size",value = "条数")
     * })
     */

}
